Skip to content

Picky correctness improvement to inline TOML comment in policy template. - #442

Merged
ximon18 merged 2 commits into
mainfrom
tweak-send-notify-to-toml-inline-docs
Jun 10, 2026
Merged

Picky correctness improvement to inline TOML comment in policy template.#442
ximon18 merged 2 commits into
mainfrom
tweak-send-notify-to-toml-inline-docs

Conversation

@ximon18

@ximon18 ximon18 commented Feb 2, 2026

Copy link
Copy Markdown
Member

send-notify-to requires quoted IP:[port] values but the TOML doc doesn't mention the quotes, and unlike the server address binding examples in the main config file, here there is no default value making the syntax self-documenting. It also says a collection while strictly speaking it should be a set, and to be even more pedantic I noted that it should be comma-separated.

`send-notify-to` requires quoted `IP:[port]` values but the TOML doc doesn't mention the quotes, and unlike the server address binding examples in the main config file, here there is no default value making the syntax self-documenting. It also says a collection while strictly speaking it should be a set, and to be even more pedantic I noted that it should be comma-separated.
@ximon18 ximon18 added the documentation Improvements or additions to documentation label Feb 2, 2026

@bal-e bal-e left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that the comment should be more descriptive, but I'm worried about the phrase "comma-separated". For anybody who is familiar with TOML, "comma-separated" can also cause confusion. Perhaps we should just provides some concrete examples (while also adding quotations around "IP:[port]")?

@ximon18

ximon18 commented Jun 9, 2026

Copy link
Copy Markdown
Member Author

I agree that the comment should be more descriptive, but I'm worried about the phrase "comma-separated". For anybody who is familiar with TOML, "comma-separated" can also cause confusion. Perhaps we should just provides some concrete examples (while also adding quotations around "IP:[port]")?

I made some changes and synced with main, please re-review.

@ximon18
ximon18 merged commit 13b91df into main Jun 10, 2026
9 checks passed
@ximon18
ximon18 deleted the tweak-send-notify-to-toml-inline-docs branch June 10, 2026 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants